home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 018a / compr.zip / USAGE.DOC < prev   
Text File  |  1991-11-18  |  5KB  |  106 lines
  1.               WHITEWARE'S COMPARE FOR WORDPERFECT*
  2.                   Copyright 1991 James H. White
  3.  
  4.                            USAGE NOTES
  5.  
  6.           COMPARE is designed to perform word-for-word comparison
  7. of WordPerfect* documents, what some folks call "legislation-
  8. style" document comparison.  If you've used Wordperfect's*
  9. comparison routine [Alt-F5,6,2], you're accustomed to phrase
  10. oriented redlining, where each document phrase is shown as
  11. deleted or redlined.  In Wordperfect's* comparison, a phrase is a
  12. section of text delimited by comma, period, colon, semicolon,
  13. question mark, exclamation mark, or hard return.  So, if you
  14. change one word in a long clause, WordPerfect* will show the
  15. entire clause struck and then show the entire new clause in red-
  16. line.
  17.  
  18.           For most of my work, a word-for-word comparison is more
  19. useful than phrase by phrase, and I wrote this utility program to
  20. accomplish such comparison.  While I wrote it for other use, I
  21. was surprised to discover the program was extraordinarily useful
  22. for comparing versions of programs.
  23.  
  24.           COMPARE works (mostly) by brute force, with every word
  25. in a source document compared with every word in a secondary
  26. document to create a giant list of paired pointers.  Speed and
  27. file size are optimized with a couple of tricks, but the basic
  28. approach is still a word-by-word comparison. The resulting
  29. pointer list is culled to eliminate criss-crossing pointers and
  30. maximize the matches between the two documents.
  31.  
  32.           By default, deleted material will be shown in strike-
  33. out, added material will be shown in double-underline.  The
  34. CONFIGCD utility allows you to specify the method of comparison
  35. display.  You may select strike-out to designate deleted
  36. material, or [brackets], <crooked brackets> or <^> to show that
  37. material has been deleted without setting it out at length.  For
  38. new material, you may select redlining (as in Wordperfect),
  39. underlining, double-underlining, bold, or you may combine bold
  40. with any of the other three designations.
  41.  
  42.           REQUIREMENTS AND LIMITATIONS.
  43.  
  44.           Documents may be up to 64K in size.  This is an
  45. intentional limitation to avoid unreasonably long processing
  46. times.  On the rare occasion when I need to compare longer
  47. documents, I split them into smaller pieces and compare the
  48. resulting subdocuments.
  49.  
  50.           A hard disk is essential.  While the COMPARE program
  51. would run from floppy, the amount of disk-access would slow the
  52. operation down excessively.  Also, there must be a fair amount of
  53. available space on the disk for the temporary pointer files.  How
  54. much is needed depends on the size of the documents and the
  55. degree of change between the two documents, but as much as a meg
  56. might be necessary.
  57.  
  58.           Choose a display option that does not duplicate codes
  59. in your original documents.
  60.  
  61.           I think of this version of the program as a "late beta"
  62. edition.  It works, and works well, but there may be glitches
  63. that could show up in documents which contain obscure WordPerfect
  64. codes.  Eventually, I intend to do a final version, and welcome
  65. suggestions to improve the operation or usability of the program. 
  66. The two changes I have in mind at this point are to build in a
  67. point-and-shoot directory display and to make the comparison more
  68. "intelligent."  Also, if WordPerfect is augmented with new codes,
  69. I will cope with these.
  70.  
  71.           COMMENTS
  72.  
  73.           In documents with limited changes, the program will
  74. generate a couple of "File error" messages (882 and 917).  These
  75. are left over from debugging work, and do not affect the
  76. operation of the program.
  77.  
  78.           The double-underline codes may not work with certain
  79. printer drivers, since the printer does not support this
  80. typography.  If a COMPARE document is retrieved with such a
  81. driver selected, WordPerfect will convert these codes to single-
  82. underline.
  83.  
  84.           REGISTRATION.
  85.  
  86.           As usual in shareware, registration is on the honor
  87. system.  If you find the program useful and continue using it,
  88. you are asked to register and pay the registration fee of $20. 
  89. The eventual final program will be sent to paid registrants at no
  90. additional cost.  You may also do "free" registration, which will
  91. put your name on the mailing list to be notified of the final
  92. product.
  93.  
  94.           To register, print REGISTER.DOC from the DOS prompt by
  95. entering COPY REGISTER.DOC PRN <enter>.
  96.  
  97.           CALL OR SEND SUGGESTIONS.
  98.  
  99.           I'd be grateful for suggestions for enhancement or
  100. corrections.  If you find a bug in the program operation, please
  101. send me the actual documents ("old" and "new") on disk or upload
  102. to Compuserve 72060,1152.  Notes to me on Compuserve will also be
  103. answered.
  104.  
  105.           *WordPerfect is a registered trademark of WordPerfect
  106. Corporation.